Skip to content

get_block_wrapper_attributes: Ensures that user-provided attributes override the attributes generated by block supports#10922

Closed
t-hamano wants to merge 33 commits intoWordPress:trunkfrom
t-hamano:64564-get-block-wrapper-attributes
Closed

get_block_wrapper_attributes: Ensures that user-provided attributes override the attributes generated by block supports#10922
t-hamano wants to merge 33 commits intoWordPress:trunkfrom
t-hamano:64564-get-block-wrapper-attributes

Conversation

@t-hamano
Copy link
Copy Markdown
Contributor

@t-hamano t-hamano commented Feb 13, 2026

Note

This PR is the same as #10877. I submitted this new PR because I accidentally closed #10877 and it can no longer be reopened.

Trac ticket: https://core.trac.wordpress.org/ticket/64603


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

t-hamano and others added 6 commits February 13, 2026 19:47
…verride the attributes generated by block supports
Co-authored-by: Weston Ruter <[email protected]>
Co-authored-by: Weston Ruter <[email protected]>
Co-authored-by: Weston Ruter <[email protected]>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 13, 2026

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props wildworks, westonruter.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions
Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Comment thread src/wp-includes/class-wp-block-supports.php Outdated

$attributes[ $attribute_name ] = $extra_attributes[ $attribute_name ] . ' ' . $new_attributes[ $attribute_name ];
if ( $is_merged ) {
$attributes[ $attribute_name ] = $extra_attributes[ $attribute_name ] . ' ' . $new_attributes[ $attribute_name ];
Copy link
Copy Markdown
Member

@westonruter westonruter Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For posterity, #10877 (comment):

In the case of merging style, should special handling be added to ensure that $extra_attributes[ $attribute_name ] ends in a semicolon? The current empty space is only really appropriate for class.

@t-hamano
Copy link
Copy Markdown
Contributor Author

Sorry for the late reply.

After some consideration, I decided to refactor the get_block_wrapper_attributes() function overall to make it more robust and secure.

  • Define callback functions that define how to merge or override each attribute.
  • Sanitize style and class attribute values
  • More flexibly handle redundant semicolons in style attributes
  • Added a unit test to directly assert the return value of get_block_wrapper_attributes().

Comment on lines +214 to +215
$new_attribute = is_string( $new_attribute ) ? $new_attribute : '';
$extra_attribute = is_string( $extra_attribute ) ? $extra_attribute : '';
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sanitize non-string attribute values here.

);

$expected_classes = 'foo-bar-class wp-block-example has-text-color has-red-color has-background has-black-background-color';
$expected_styles = 'test: style;';
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't have used the invalid inline styles in the test in the first place.

Comment thread src/wp-includes/class-wp-block-supports.php Outdated
Comment thread src/wp-includes/class-wp-block-supports.php Outdated
Comment thread src/wp-includes/class-wp-block-supports.php Outdated
Comment thread src/wp-includes/class-wp-block-supports.php Outdated
Comment thread src/wp-includes/class-wp-block-supports.php Outdated
Comment thread src/wp-includes/class-wp-block-supports.php Outdated
Comment thread src/wp-includes/class-wp-block-supports.php Outdated
@westonruter westonruter requested a review from Copilot March 19, 2026 10:47
Comment thread tests/phpunit/tests/blocks/supportedStyles.php Outdated
Comment thread tests/phpunit/tests/blocks/supportedStyles.php Outdated
Comment thread tests/phpunit/tests/blocks/supportedStyles.php Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adjusts how get_block_wrapper_attributes() combines block-support-generated wrapper attributes with additional attributes supplied by the block renderer, and updates/extends PHPUnit coverage to reflect the new merging behavior.

Changes:

  • Refactors get_block_wrapper_attributes() to use per-attribute merge/override callbacks for style, class, id, and aria-label.
  • Normalizes merged style output (e.g., trimming redundant semicolons) and de-duplicates merged class tokens.
  • Updates supportedStyles.php expectations and adds a data-driven test for merge/override behavior.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
src/wp-includes/class-wp-block-supports.php Refactors wrapper attribute merge/override logic in get_block_wrapper_attributes().
tests/phpunit/tests/blocks/supportedStyles.php Updates expected style strings and adds a data provider test for wrapper attribute merging/overriding.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

),
'expected_attribute' => 'style="margin-top: 2px;color:#000"',
),
),
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fow now, I don't plan to merge individual CSS properties, as doing so would require more complex parsing and feels out of scope for this PR.

Comment thread src/wp-includes/class-wp-block-supports.php
Comment thread src/wp-includes/class-wp-block-supports.php Outdated
Comment thread src/wp-includes/class-wp-block-supports.php Outdated
Comment thread tests/phpunit/tests/blocks/supportedStyles.php Outdated
Comment thread tests/phpunit/tests/blocks/supportedStyles.php Outdated
public function data_get_block_wrapper_attributes_merge_or_override(): array {
return array(
'extra style attributes are merged with block values' => array(
array(
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This extra array() wrapper should be removed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch! Fixed in 21f404f

Comment on lines +761 to +768
* @param array{
* block_type_settings: array<string, mixed>,
* block_attrs: array<string, mixed>,
* extra_attributes: array<string, string>,
* expected_attribute: string
* } $data Data from the provider.
*/
public function test_get_block_wrapper_attributes_merge_and_override( $data ) {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the removal of the wrapper arrays, this can be changed to:

Suggested change
* @param array{
* block_type_settings: array<string, mixed>,
* block_attrs: array<string, mixed>,
* extra_attributes: array<string, string>,
* expected_attribute: string
* } $data Data from the provider.
*/
public function test_get_block_wrapper_attributes_merge_and_override( $data ) {
* @param array<string, mixed> $block_type_settings
* @param array<string, mixed> $block_attrs
* @param array<string, string> $extra_attributes
* @param string $expected_attribute
*/
public function test_get_block_wrapper_attributes_merge_and_override( array $block_type_settings, array $block_attrs, array $extra_attributes, string $expected_attribute ): void {

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 21f404f

@t-hamano
Copy link
Copy Markdown
Contributor Author

@westonruter Thanks for the review!

@t-hamano t-hamano closed this Mar 19, 2026
@t-hamano t-hamano reopened this Mar 19, 2026
@github-actions
Copy link
Copy Markdown

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 62068
GitHub commit: ea53b95

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

@github-actions github-actions Bot closed this Mar 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants